Window: Clarify resize() doc about titlebar widget
authorDaniel Boles <dboles@src.gnome.org>
Fri, 12 Jan 2018 21:22:11 +0000 (21:22 +0000)
committerDaniel Boles <dboles@src.gnome.org>
Fri, 12 Jan 2018 23:03:44 +0000 (23:03 +0000)
Clarify the reference to HeaderBar, as it applies to any custom title
widget; HeaderBar is only the most common one used. Also, fix a typo.

gtk/gtkwindow.c

index 2821f251ffee514260f78cd26abb5fb819ddb008..d4bc48c2e158773770d61703dfa9b9b0e82283d5 100644 (file)
@@ -5355,16 +5355,17 @@ gtk_window_get_default_size (GtkWindow *window,
  * When using client side decorations, GTK+ will do its best to adjust
  * the given size so that the resulting window size matches the
  * requested size without the title bar, borders and shadows added for
- * the client side decorations, but there is no garantee that the
+ * the client side decorations, but there is no guarantee that the
  * result will be totally accurate because these widgets added for
  * client side decorations depend on the theme and may not be realized
  * or visible at the time gtk_window_resize() is issued.
  *
- * Typically, gtk_window_resize() will compensate for the GtkHeaderBar
- * height only if it's known at the time the resulting GtkWindow
- * configuration is issued.
+ * If the GtkWindow has a titlebar widget (see gtk_window_set_titlebar()), then
+ * typically, gtk_window_resize() will compensate for the height of the titlebar
+ * widget only if the height is known when the resulting GtkWindow configuration
+ * is issued.
  * For example, if new widgets are added after the GtkWindow configuration
- * and cause the GtkHeaderBar to grow in height, this will result in a
+ * and cause the titlebar widget to grow in height, this will result in a
  * window content smaller that specified by gtk_window_resize() and not
  * a larger window.
  *